home *** CD-ROM | disk | FTP | other *** search
/ Aminet 12 / Aminet 12 (1996)(GTI - Schatztruhe)[!][Jun 1996].iso / Aminet / dev / c / PhoneLogDevKit.lha / PhoneLog / docs / PhoneLogParser.doc < prev   
Encoding:
Text File  |  1996-03-16  |  2.3 KB  |  103 lines
  1. TABLE OF CONTENTS
  2.  
  3. PhoneLogParser/InsertPhoneLogEntry
  4. PhoneLogParser/InsertPhoneLogMark
  5. PhoneLogParser/ParsePhoneLogFile
  6. PhoneLogParser/InsertPhoneLogEntry
  7.  
  8.    NAME
  9.         InsertPhoneLogEntry -- Insert a parsed entry into your program (V33)
  10.  
  11.    SYNOPSIS
  12.         InsertPhoneLogEntry(item);
  13.  
  14.         void InsertPhoneLogEntry(struct PhoneLogEntry *item);
  15.  
  16.    FUNCTION
  17.         This function will be called by the parser to insert a phone log
  18.         entry into your software.
  19.         So please modify the function body according to your needs!
  20.  
  21.    INPUTS
  22.         item - PhoneLogEntry structure to insert into your program.
  23.  
  24.    RESULT
  25.         None
  26.  
  27.    NOTES
  28.         Don't forget to return to the parser after you have inserted the
  29.         item into your program!
  30.  
  31.    BUGS
  32.         No known bugs.
  33.  
  34.    SEE ALSO
  35.         ParsePhoneLogFile(), InsertPhoneLogMark()
  36. PhoneLogParser/InsertPhoneLogMark
  37.  
  38.    NAME
  39.         InsertPhoneLogMark -- Insert a parsed mark into your program (V33)
  40.  
  41.    SYNOPSIS
  42.         InsertPhoneLogMark(item);
  43.  
  44.         void InsertPhoneLogMark(struct PhoneLogMarker *item);
  45.  
  46.    FUNCTION
  47.         This function will be called by the parser to insert a phone log
  48.         mark into your software.
  49.         So please modify the function body according to your needs!
  50.  
  51.    INPUTS
  52.         item - PhoneLogMarker structure to insert into your program.
  53.  
  54.    RESULT
  55.         None
  56.  
  57.    NOTES
  58.         Don't forget to return to the parser after you have inserted the
  59.         item into your program!
  60.  
  61.    BUGS
  62.         No known bugs.
  63.  
  64.    SEE ALSO
  65.         ParsePhoneLogFile(), InsertPhoneLogEntry()
  66. PhoneLogParser/ParsePhoneLogFile
  67.  
  68.    NAME
  69.         ParsePhoneLogFile -- Parse a log file (V33)
  70.  
  71.    SYNOPSIS
  72.         NumOfParseErrs = ParsePhoneLogFile(name);
  73.  
  74.         int ParsePhoneLogFile(char *filename);
  75.  
  76.    FUNCTION
  77.         Parse a log file.
  78.  
  79.    INPUTS
  80.         name - The name of the log file.
  81.  
  82.    RESULT
  83.         NumOfParseErrs - Number of occured parse errors.
  84.  
  85.    EXAMPLE
  86.         ...
  87.         if (ParsePhoneLogFile("AmiTCP:log/AmiLog.log") != 0)
  88.          {
  89.           \* Parse errors have occured *\
  90.          }
  91.         ...
  92.  
  93.    NOTES
  94.         This function uses  InsertPhoneLogEntry() and InsertPhoneLogMark()
  95.         as callback functions so that you can insert parsed datas into your
  96.         program.
  97.  
  98.    BUGS
  99.         No known bugs.
  100.  
  101.    SEE ALSO
  102.         InsertPhoneLogEntry(), InsertPhoneLogMark()
  103.